Class com.symantec.itools.vcafe.openapi.options.EnvironmentFormatOptions

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.options.EnvironmentFormatOptions

Object
   |
   +----com.symantec.itools.vcafe.openapi.options.EnvironmentFormatOptions

public abstract class EnvironmentFormatOptions
extends Object

The API used to represent and access the format-related options of the Visual Cafe environment. These options that appear in the "Format" tab in the Environment Options dialog.

Use EnvironmentOptionSet.getFormatOptions() to get an instance of this object.

Version:: 1.0
Author:: Symantec Internet Tools Division
Since:: VCafe 3.0
See Also:: getEnvironmentOptionSet, getFormatOptions

FORMATFOR_HTML: Indicates the requested format option pertains to .html windows.
FORMATFOR_IDL: Indicates the requested format option pertains to .idl windows.
FORMATFOR_JAVA: Indicates the requested format option pertains to .java windows.
FORMATFOR_UNKNOWN: Indicates the requested format option pertains to unknown/unmapped windows.
FORMATFOR_UNTITLED: Indicates the requested format option pertains to untitled windows.
LANGUAGESYNTAX_CPP: Indicates C++ syntax and keyword highlighting.
LANGUAGESYNTAX_HTML: Indicates Html syntax and keyword highlighting.
LANGUAGESYNTAX_IDL: Indicates IDL syntax and keyword highlighting.
LANGUAGESYNTAX_JAVA: Indicates Java syntax and keyword highlighting.
LANGUAGESYNTAX_MFC: Indicates MFC syntax and keyword highlighting.
LANGUAGESYNTAX_NONE: Indicates no syntax or keyword highlighting.

com.symantec.itools.vcafe.openapi.options.EnvironmentFormatOptions()

getIndentCommentsAt(String): Gets the comment indentation column.
getIndentWidth(String): Gets the number of columns to indent lines.
getLanguageSyntax(String): Gets the language used for syntax and keyword highlighting for this type of window.
getRightMargin(String): Gets the column that acts as the right margin for word wrapping.
getTabWidth(String): Gets the number of columns between tab stops (1-16).
isChangeTabsToSpaces(String): Determines whether while typing, tabs are inserted into the text as an appropriate number of spaces, rather than as tab characters.
isCheckDelimiters(String): Determines whether while typing, if you type a right parenthesis, square bracket, or brace, the editor briefly highlights the corresponding left delimiter.
isEnableCustomKeywords(String): Determines if custom keywords are highlighted in this type of window.
isIndentAfterBrace(String): Determines whether while typing, if the last character typed on a line is a left brace, the next line is automatically indented by an extra tab stop.
isIndentAutomatically(String): Determines whether while typing, newlines are automatically indented.
isIndentComments(String): Determines whether while typing comments, the editor automatically indents it to a specified alignment column when you type "//" or "/*" to start a comment.
isRemoveTrailingSpaces(String): Determines whether trailing spaces and tabs are removed from the end of each line when a file is saved.
isWordWrap(String): Determines whether while typing, lines that extend beyond the right margin are automatically broken at the last word boundary before the margin.

FORMATFOR_HTML

public static final java.lang.String FORMATFOR_HTML

Indicates the requested format option pertains to .html windows.

FORMATFOR_IDL

public static final java.lang.String FORMATFOR_IDL

Indicates the requested format option pertains to .idl windows.

FORMATFOR_JAVA

public static final java.lang.String FORMATFOR_JAVA

Indicates the requested format option pertains to .java windows.

FORMATFOR_UNKNOWN

public static final java.lang.String FORMATFOR_UNKNOWN

Indicates the requested format option pertains to unknown/unmapped windows.

FORMATFOR_UNTITLED

public static final java.lang.String FORMATFOR_UNTITLED

Indicates the requested format option pertains to untitled windows.

LANGUAGESYNTAX_CPP

public static final int LANGUAGESYNTAX_CPP

Indicates C++ syntax and keyword highlighting.

See Also:: getLanguageSyntax

LANGUAGESYNTAX_HTML

public static final int LANGUAGESYNTAX_HTML

Indicates Html syntax and keyword highlighting.

See Also:: getLanguageSyntax

LANGUAGESYNTAX_IDL

public static final int LANGUAGESYNTAX_IDL

Indicates IDL syntax and keyword highlighting.

See Also:: getLanguageSyntax

LANGUAGESYNTAX_JAVA

public static final int LANGUAGESYNTAX_JAVA

Indicates Java syntax and keyword highlighting.

See Also:: getLanguageSyntax

LANGUAGESYNTAX_MFC

public static final int LANGUAGESYNTAX_MFC

Indicates MFC syntax and keyword highlighting.

See Also:: getLanguageSyntax

LANGUAGESYNTAX_NONE

public static final int LANGUAGESYNTAX_NONE

Indicates no syntax or keyword highlighting.

See Also:: getLanguageSyntax

EnvironmentFormatOptions

public EnvironmentFormatOptions()

getIndentCommentsAt

public abstract int getIndentCommentsAt(String formatFor)

Gets the comment indentation column. This setting is only applicable if isIndentComments is true.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

the column to indent comments to.

getIndentWidth

public abstract int getIndentWidth(String formatFor)

Gets the number of columns to indent lines.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

the number of columns for line indentation.

getLanguageSyntax

public abstract int getLanguageSyntax(String formatFor)

Gets the language used for syntax and keyword highlighting for this type of window.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

the language for this window. Can be one of:

LANGUAGESYNTAX_NONE - indicates no syntax highlighting,
LANGUAGESYNTAX_JAVA - highlighting for Java keywords,
LANGUAGESYNTAX_HTML - highlighting for Html keywords,
LANGUAGESYNTAX_CPP - highlighting for C++ keywords,
LANGUAGESYNTAX_MFC - highlighting for MFC keywords, or
LANGUAGESYNTAX_IDL - highlighting for idl keywords.

getRightMargin

public abstract int getRightMargin(String formatFor)

Gets the column that acts as the right margin for word wrapping. (1-512).

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

the right margin column.

getTabWidth

public abstract int getTabWidth(String formatFor)

Gets the number of columns between tab stops (1-16). The default is four character widths.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

the number of columns between tab stops.

isChangeTabsToSpaces

public abstract boolean isChangeTabsToSpaces(String formatFor)

Determines whether while typing, tabs are inserted into the text as an appropriate number of spaces, rather than as tab characters.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

true if tabs are changed to spaces, false otherwise.

isCheckDelimiters

public abstract boolean isCheckDelimiters(String formatFor)

Determines whether while typing, if you type a right parenthesis, square bracket, or brace, the editor briefly highlights the corresponding left delimiter.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

true if delimiter checking is enabled, false otherwise.

isEnableCustomKeywords

public abstract boolean isEnableCustomKeywords(String formatFor)

Determines if custom keywords are highlighted in this type of window.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

true if custom keyword highlighting is enabled, false otherwise.

isIndentAfterBrace

public abstract boolean isIndentAfterBrace(String formatFor)

Determines whether while typing, if the last character typed on a line is a left brace, the next line is automatically indented by an extra tab stop. This option only works if Indent Automatically is selected in the buffer.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

true if post-brace indenting is enabled, false otherwise.

isIndentAutomatically

public abstract boolean isIndentAutomatically(String formatFor)

Determines whether while typing, newlines are automatically indented. When you press ENTER, the editor positions the cursor directly below the first character in the previous line.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

true if new lines are indented, false otherwise.

isIndentComments

public abstract boolean isIndentComments(String formatFor)

Determines whether while typing comments, the editor automatically indents it to a specified alignment column when you type "//" or "/*" to start a comment.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

true if comments are automatically indented, false otherwise.

isRemoveTrailingSpaces

public abstract boolean isRemoveTrailingSpaces(String formatFor)

Determines whether trailing spaces and tabs are removed from the end of each line when a file is saved.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

true if trailing spaces are removed, false otherwise.

isWordWrap

public abstract boolean isWordWrap(String formatFor)

Determines whether while typing, lines that extend beyond the right margin are automatically broken at the last word boundary before the margin.

Parameters:

formatFor - the type of window for the requested format option. Can be one of:

FORMATFOR_UNTITLED - format options for untitled windows,
FORMATFOR_UNKNOWN - format options for unknown windows,
FORMATFOR_JAVA - format options for java windows,
FORMATFOR_HTML - format options for html windows,
FORMATFOR_IDL - format options for idl windows, or
any other extension that for which you've added format options.

Returns:

true if word wrap is enabled, false otherwise.

All Packages  Class Hierarchy  This Package  Previous  Next  Index